Skip to content

docs: add SSTS_MANIFEST and SSTS_STORAGE system tables #2198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 7 commits into from
Nov 11, 2025
Merged

docs: add SSTS_MANIFEST and SSTS_STORAGE system tables #2198

merged 7 commits into from
Nov 11, 2025

Conversation

Copy link
Contributor

Copilot AI commented Nov 6, 2025 •
edited
Loading

What's Changed in this PR

Added documentation for two new INFORMATION_SCHEMA tables introduced in GreptimeDB PR #6924:

SSTS_MANIFEST - SST file metadata from manifest

  • 20 fields including file paths, sizes, levels, time ranges, row counts, visibility status
  • Query SST files by table, level, time range, or visibility
  • Calculate storage metrics per table

SSTS_STORAGE - SST files from storage layer

  • 4 fields: file path, size, last modified timestamp, node ID
  • Detect orphaned files by comparing against manifest
  • Audit storage layer for inconsistencies

Both tables documented in English and Chinese with:

  • Complete schema descriptions and field explanations
  • Practical SQL examples and use cases
  • Consistent Markdown style matching SSTS_INDEX_META reference:
    • Blank line before "Output example:" sections
    • "输出样例" for output examples in Chinese
  • Consistent terminology aligned with SSTS_INDEX_META:
    • "清单" for "manifest" in Chinese
    • "Region" (capitalized) for region references in Chinese
    • "数据节点 ID" for datanode ID in Chinese
  • Navigation entries added to sidebars.ts for proper integration into the documentation structure

Checklist

  • Please confirm that all corresponding versions of the documents have been revised.
  • Please ensure that the content in sidebars.ts matches the current document structure when you changed the document structure.
  • This change requires follow-up update in localized docs.

Fixes #2108

Original prompt

This section details on the original issue you should resolve

<issue_title>Update docs for feat: add ssts releated system table</issue_title>
<issue_description>A document change request is generated from GreptimeTeam/greptimedb#6924</issue_description>

<agent_instructions>Only update nightly document</agent_instructions>

Comments on the Issue (you are @copilot in this section)

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Nov 6, 2025 •
edited
Loading

Deploying greptime-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5281403
Status: ✅  Deploy successful!
Preview URL: https://17951de5.greptime-docs.pages.dev
Branch Preview URL: https://copilot-update-nightly-docum.greptime-docs.pages.dev

View logs

Copilot AI changed the title [WIP] Update docs for system table related to SSTS docs: add SSTS_MANIFEST and SSTS_STORAGE system tables Nov 6, 2025
Copilot AI requested a review from WenyXu November 6, 2025 07:30
Copilot finished work on behalf of WenyXu November 6, 2025 07:30
@WenyXu WenyXu marked this pull request as ready for review November 11, 2025 03:23
@WenyXu
Copy link
Member

WenyXu commented Nov 11, 2025

@copilot you should update sidebar.ts file.

Copy link
Contributor Author

Copilot AI commented Nov 11, 2025

@copilot you should update sidebar.ts file.

Updated sidebars.ts to include both new tables in the Information Schema navigation section. The changes are in commit d198e42.

Copilot finished work on behalf of WenyXu November 11, 2025 03:35
@WenyXu
Copy link
Member

WenyXu commented Nov 11, 2025

@copilot Please keep the existing Markdown style (both English and Chinese). See SSTS_INDEX_META for reference.

Copy link
Contributor Author

Copilot AI commented Nov 11, 2025

@copilot Please keep the existing Markdown style (both English and Chinese). See SSTS_INDEX_META for reference.

Fixed Markdown style to match SSTS_INDEX_META:

  • Added blank line before "Output example:" in English docs
  • Changed "输出示例" to "输出样例" in Chinese docs

Changes are in commit 96e0b0f.

Copilot finished work on behalf of WenyXu November 11, 2025 03:46
@WenyXu
Copy link
Member

WenyXu commented Nov 11, 2025

@copilot Please align the terminology with existing docs (e.g., SSTS_INDEX_META), and keep the Chinese version consistent with existing Chinese writing style.

Copy link
Contributor Author

Copilot AI commented Nov 11, 2025

@copilot Please align the terminology with existing docs (e.g., SSTS_INDEX_META), and keep the Chinese version consistent with existing Chinese writing style.

Aligned Chinese terminology with SSTS_INDEX_META:

  • Capitalized "Region" for region references
  • Changed "datanode ID" to "数据节点 ID"
  • Changed "manifest" to "清单" in example descriptions

Changes are in commit f97e7f8.

Copilot finished work on behalf of WenyXu November 11, 2025 03:59
WenyXu
WenyXu reviewed Nov 11, 2025
View reviewed changes
@fengjiachun fengjiachun merged commit 58a6084 into main Nov 11, 2025
5 checks passed
@fengjiachun fengjiachun deleted the copilot/update-nightly-document branch November 11, 2025 08:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@WenyXu WenyXu WenyXu left review comments

@fengjiachun fengjiachun fengjiachun approved these changes

@discord9 discord9 discord9 approved these changes

@nicecui nicecui Awaiting requested review from nicecui nicecui is a code owner

Assignees

@WenyXu WenyXu

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update docs for feat: add ssts releated system table

4 participants

@WenyXu @fengjiachun @discord9